<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>xilnvm: XilNvm BBRAM Client APIs</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">xilnvm
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;"
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__xnvm__bbram__client__api.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">XilNvm BBRAM Client APIs</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga16b69cce167bd701e56511c099fdf150"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xnvm__bbram__client__api.html#ga16b69cce167bd701e56511c099fdf150">XNVM_SLR_INDEX_SHIFT</a>&#160;&#160;&#160;(6U)</td></tr>
<tr class="memdesc:ga16b69cce167bd701e56511c099fdf150"><td class="mdescLeft">&#160;</td><td class="mdescRight">&lt; shift constant to place slr id  <a href="#ga16b69cce167bd701e56511c099fdf150">More...</a><br/></td></tr>
<tr class="separator:ga16b69cce167bd701e56511c099fdf150"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3b6228f47fedbf81e4a4d428a59f2ed4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xnvm__bbram__client__api.html#ga3b6228f47fedbf81e4a4d428a59f2ed4">XNVM_SLR_INDEX_0</a>&#160;&#160;&#160;(0U)</td></tr>
<tr class="memdesc:ga3b6228f47fedbf81e4a4d428a59f2ed4"><td class="mdescLeft">&#160;</td><td class="mdescRight">SLR Index 0.  <a href="#ga3b6228f47fedbf81e4a4d428a59f2ed4">More...</a><br/></td></tr>
<tr class="separator:ga3b6228f47fedbf81e4a4d428a59f2ed4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa11ceca8fb47cd6c3448fd647a144a93"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xnvm__bbram__client__api.html#gaa11ceca8fb47cd6c3448fd647a144a93">XNVM_SLR_INDEX_1</a>&#160;&#160;&#160;(1U)</td></tr>
<tr class="memdesc:gaa11ceca8fb47cd6c3448fd647a144a93"><td class="mdescLeft">&#160;</td><td class="mdescRight">SLR Index 1.  <a href="#gaa11ceca8fb47cd6c3448fd647a144a93">More...</a><br/></td></tr>
<tr class="separator:gaa11ceca8fb47cd6c3448fd647a144a93"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaab93353d8da089021e9539b33d3ce7e0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xnvm__bbram__client__api.html#gaab93353d8da089021e9539b33d3ce7e0">XNVM_SLR_INDEX_2</a>&#160;&#160;&#160;(2U)</td></tr>
<tr class="memdesc:gaab93353d8da089021e9539b33d3ce7e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">SLR Index 2.  <a href="#gaab93353d8da089021e9539b33d3ce7e0">More...</a><br/></td></tr>
<tr class="separator:gaab93353d8da089021e9539b33d3ce7e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae83bff3d807531eee2767b16d00a54f4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xnvm__bbram__client__api.html#gae83bff3d807531eee2767b16d00a54f4">XNVM_SLR_INDEX_3</a>&#160;&#160;&#160;(3U)</td></tr>
<tr class="memdesc:gae83bff3d807531eee2767b16d00a54f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">SLR Index 3.  <a href="#gae83bff3d807531eee2767b16d00a54f4">More...</a><br/></td></tr>
<tr class="separator:gae83bff3d807531eee2767b16d00a54f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga3a9878e9a0eb1071cd34c4d14d842f10"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xnvm__bbram__client__api.html#ga3a9878e9a0eb1071cd34c4d14d842f10">XNvm_BbramWriteAesKey</a> (const XNvm_ClientInstance *InstancePtr, const u64 KeyAddr, const u32 KeyLen)</td></tr>
<tr class="memdesc:ga3a9878e9a0eb1071cd34c4d14d842f10"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to program BBRAM AES key.  <a href="#ga3a9878e9a0eb1071cd34c4d14d842f10">More...</a><br/></td></tr>
<tr class="separator:ga3a9878e9a0eb1071cd34c4d14d842f10"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae4085a2c2243377cae4029f3236684e7"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xnvm__bbram__client__api.html#gae4085a2c2243377cae4029f3236684e7">XNvm_BbramZeroize</a> (const XNvm_ClientInstance *InstancePtr)</td></tr>
<tr class="memdesc:gae4085a2c2243377cae4029f3236684e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to zeroize the BBRAM.  <a href="#gae4085a2c2243377cae4029f3236684e7">More...</a><br/></td></tr>
<tr class="separator:gae4085a2c2243377cae4029f3236684e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga99bad6a63ce3e2663bd7976371598b4f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xnvm__bbram__client__api.html#ga99bad6a63ce3e2663bd7976371598b4f">XNvm_BbramWriteUsrData</a> (const XNvm_ClientInstance *InstancePtr, const u32 UsrData)</td></tr>
<tr class="memdesc:ga99bad6a63ce3e2663bd7976371598b4f"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to write the user data into BBRAM user data registers.  <a href="#ga99bad6a63ce3e2663bd7976371598b4f">More...</a><br/></td></tr>
<tr class="separator:ga99bad6a63ce3e2663bd7976371598b4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8cdf06389845d0a30a2d48ae3373b72b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xnvm__bbram__client__api.html#ga8cdf06389845d0a30a2d48ae3373b72b">XNvm_BbramReadUsrData</a> (const XNvm_ClientInstance *InstancePtr, const u64 OutDataAddr)</td></tr>
<tr class="memdesc:ga8cdf06389845d0a30a2d48ae3373b72b"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to read the BBRAM user data.  <a href="#ga8cdf06389845d0a30a2d48ae3373b72b">More...</a><br/></td></tr>
<tr class="separator:ga8cdf06389845d0a30a2d48ae3373b72b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5ab6ca734ee3f575632ba1c88164d182"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xnvm__bbram__client__api.html#ga5ab6ca734ee3f575632ba1c88164d182">XNvm_BbramLockUsrDataWrite</a> (const XNvm_ClientInstance *InstancePtr)</td></tr>
<tr class="memdesc:ga5ab6ca734ee3f575632ba1c88164d182"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to lock the updates to user data written to BBRAM_8 register.  <a href="#ga5ab6ca734ee3f575632ba1c88164d182">More...</a><br/></td></tr>
<tr class="separator:ga5ab6ca734ee3f575632ba1c88164d182"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga3b6228f47fedbf81e4a4d428a59f2ed4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XNVM_SLR_INDEX_0&#160;&#160;&#160;(0U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>SLR Index 0. </p>

<p>Referenced by <a class="el" href="group__xnvm__apis.html#ga840291bc02cba5474a4cb46a9b9566fe">main()</a>.</p>

</div>
</div>
<a class="anchor" id="gaa11ceca8fb47cd6c3448fd647a144a93"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XNVM_SLR_INDEX_1&#160;&#160;&#160;(1U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>SLR Index 1. </p>

</div>
</div>
<a class="anchor" id="gaab93353d8da089021e9539b33d3ce7e0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XNVM_SLR_INDEX_2&#160;&#160;&#160;(2U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>SLR Index 2. </p>

</div>
</div>
<a class="anchor" id="gae83bff3d807531eee2767b16d00a54f4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XNVM_SLR_INDEX_3&#160;&#160;&#160;(3U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>SLR Index 3. </p>

</div>
</div>
<a class="anchor" id="ga16b69cce167bd701e56511c099fdf150"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XNVM_SLR_INDEX_SHIFT&#160;&#160;&#160;(6U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>&lt; shift constant to place slr id </p>
<p>SlrIndexs constants </p>

<p>Referenced by <a class="el" href="group__xnvm__bbram__client__api.html#ga5ab6ca734ee3f575632ba1c88164d182">XNvm_BbramLockUsrDataWrite()</a>, <a class="el" href="group__xnvm__bbram__client__api.html#ga8cdf06389845d0a30a2d48ae3373b72b">XNvm_BbramReadUsrData()</a>, <a class="el" href="group__xnvm__bbram__client__api.html#ga3a9878e9a0eb1071cd34c4d14d842f10">XNvm_BbramWriteAesKey()</a>, <a class="el" href="group__xnvm__bbram__client__api.html#ga99bad6a63ce3e2663bd7976371598b4f">XNvm_BbramWriteUsrData()</a>, <a class="el" href="group__xnvm__bbram__client__api.html#gae4085a2c2243377cae4029f3236684e7">XNvm_BbramZeroize()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#gaa14ae0e8b42bf8801a510e2f31e29c88">XNvm_EfuseReadBootEnvCtrlBits()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#ga15ea0137369d9a81a853a6784c43b29d">XNvm_EfuseReadDecOnly()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#gacb7ff4ed433334fd4c7af398a6698be6">XNvm_EfuseReadDna()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#gabbff97b78f82ae83002d64c9e4e61964">XNvm_EfuseReadIv()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#gaf3ba1177b7892366982f77d32ec7ecf8">XNvm_EfuseReadMiscCtrlBits()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#ga55a6be49ea504c9e07a532b5e82797c1">XNvm_EfuseReadOffchipRevokeId()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#gad7ea5c5b0c9de1c1e6b4c2659a02ddeb">XNvm_EfuseReadPpkHash()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#ga6a1e538568cd6b7e21084eaf138a3113">XNvm_EfuseReadPuf()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#gae98054231a90a3ded1ec82c9a011ac94">XNvm_EfuseReadPufSecCtrlBits()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#ga32e43ec62893f850f115f3ee0a5434f9">XNvm_EfuseReadRevocationId()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#gae6cbda607227cfb4778b66c8c2a8ebf0">XNvm_EfuseReadSecCtrlBits()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#gacc863c22d5d7a8f54f7d3cb28781a82e">XNvm_EfuseReadSecMisc1Bits()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#ga1a3da417c5ca5121f4c8d375bf0ea298">XNvm_EfuseReadUserFuses()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#ga6615e748856e15f3e2169f9413e7cbd1">XNvm_EfuseRevokePpk()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#gaefb1c21b807d6bb2cd0725d0bdc473af">XNvm_EfuseWrite()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#ga7ed0e93e0e8a58ecfc5dd60e42461c15">XNvm_EfuseWriteIVs()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#gad260093cbe9bacb6d0f649b84bccd8a0">XNvm_EfuseWritePuf()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#gae09868a910eea80203d78873f4de064c">XNvm_EfuseWriteRevocationId()</a>, and <a class="el" href="group__xnvm__efuse__client__apis.html#gab49aedef8afbe4faa8a842b847cece3c">XNvm_EfuseWriteUserFuses()</a>.</p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga5ab6ca734ee3f575632ba1c88164d182"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XNvm_BbramLockUsrDataWrite </td>
          <td>(</td>
          <td class="paramtype">const XNvm_ClientInstance *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends IPI request to lock the updates to user data written to BBRAM_8 register. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the client instance</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS If the Locking is successful</li>
<li>XST_INVALID_PARAM If there is a input validation failure</li>
<li>XST_FAILURE If there is a failure </li>
</ul>
</dd></dl>
<p>Performs input parameters validation. Return XST_INVALID_PARAM, if input parameters are invalid.</p>
<p>Sends BBRAM LOCK USER DATA WRITE CDO command to PLM through IPI. Returns the response of BBRAM lock user data write status from the PLM.</p>

<p>References <a class="el" href="common_2xnvm__defs_8h.html#afefb58b4bc539bff958b4da2dbdfdd15ac6fecda349caa64872cc3355f9ce80e4">XNVM_API_ID_BBRAM_LOCK_WRITE_USER_DATA</a>, <a class="el" href="group__xnvm__mailbox__apis.html#ga3ce66c6266190912ba2552c2bc1701c7">XNvm_ProcessMailbox()</a>, and <a class="el" href="group__xnvm__bbram__client__api.html#ga16b69cce167bd701e56511c099fdf150">XNVM_SLR_INDEX_SHIFT</a>.</p>

</div>
</div>
<a class="anchor" id="ga8cdf06389845d0a30a2d48ae3373b72b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XNvm_BbramReadUsrData </td>
          <td>(</td>
          <td class="paramtype">const XNvm_ClientInstance *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const u64&#160;</td>
          <td class="paramname"><em>OutDataAddr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends IPI request to read the BBRAM user data. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the client instance </td></tr>
    <tr><td class="paramname">OutDataAddr</td><td>Address of the output buffer to store the BBRAM user data</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS If the read is successful</li>
<li>XST_INVALID_PARAM If there is a input validation failure</li>
<li>XST_FAILURE If there is a failure </li>
</ul>
</dd></dl>
<p>Performs input parameters validation. Return XST_INVALID_PARAM if input parameters are invalid.</p>
<p>Sends BBRAM READ USER DATA CDO command to PLM through IPI. Returns the response of Bbram Read user data status from the PLM.</p>

<p>References <a class="el" href="common_2xnvm__defs_8h.html#afefb58b4bc539bff958b4da2dbdfdd15ad8bb87510818d4f4fbf77feb219ab94f">XNVM_API_ID_BBRAM_READ_USER_DATA</a>, <a class="el" href="group__xnvm__mailbox__apis.html#ga3ce66c6266190912ba2552c2bc1701c7">XNvm_ProcessMailbox()</a>, and <a class="el" href="group__xnvm__bbram__client__api.html#ga16b69cce167bd701e56511c099fdf150">XNVM_SLR_INDEX_SHIFT</a>.</p>

</div>
</div>
<a class="anchor" id="ga3a9878e9a0eb1071cd34c4d14d842f10"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XNvm_BbramWriteAesKey </td>
          <td>(</td>
          <td class="paramtype">const XNvm_ClientInstance *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const u64&#160;</td>
          <td class="paramname"><em>KeyAddr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const u32&#160;</td>
          <td class="paramname"><em>KeyLen</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends IPI request to program BBRAM AES key. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the client instance </td></tr>
    <tr><td class="paramname">KeyAddr</td><td>Address of the key buffer where the key to be programmed is stored</td></tr>
    <tr><td class="paramname">KeyLen</td><td>Size of the Aes key</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS If the BBRAM programming is successful</li>
<li>XST_INVALID_PARAM If there is a input validation failure</li>
<li>XST_FAILURE If there is a failure </li>
</ul>
</dd></dl>
<p>Performs input parameters validation. Return XST_INVALID_PARAM if input parameters are invalid.</p>
<p>Sends BBRAM Write CDO command to PLM through IPI. Waits for the response from PLM. Returns the response of BBRAM aes key write status of PLM.</p>

<p>References <a class="el" href="common_2xnvm__defs_8h.html#afefb58b4bc539bff958b4da2dbdfdd15a63f341a70acf2369ab0c59f6d739a076">XNVM_API_ID_BBRAM_WRITE_AES_KEY</a>, <a class="el" href="group__xnvm__mailbox__apis.html#ga3ce66c6266190912ba2552c2bc1701c7">XNvm_ProcessMailbox()</a>, and <a class="el" href="group__xnvm__bbram__client__api.html#ga16b69cce167bd701e56511c099fdf150">XNVM_SLR_INDEX_SHIFT</a>.</p>

</div>
</div>
<a class="anchor" id="ga99bad6a63ce3e2663bd7976371598b4f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XNvm_BbramWriteUsrData </td>
          <td>(</td>
          <td class="paramtype">const XNvm_ClientInstance *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const u32&#160;</td>
          <td class="paramname"><em>UsrData</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends IPI request to write the user data into BBRAM user data registers. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the client instance </td></tr>
    <tr><td class="paramname">UsrData</td><td>User data to be written to BBRAM</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS If the BBRAM user data write successful</li>
<li>XST_INVALID_PARAM If there is a input validation failure.</li>
<li>XST_FAILURE If there is a failure </li>
</ul>
</dd></dl>
<p>Performs input parameters validation. Return XST_INVALID_PARAM if input parameters are invalid.</p>
<p>Sends BBRAM WRITE USER DATA CDO command to PLM IPI. Returns the response of Bbram write user data status from the PLM.</p>

<p>References <a class="el" href="common_2xnvm__defs_8h.html#afefb58b4bc539bff958b4da2dbdfdd15a24a0115494a63b9142244840b17516af">XNVM_API_ID_BBRAM_WRITE_USER_DATA</a>, <a class="el" href="group__xnvm__mailbox__apis.html#ga3ce66c6266190912ba2552c2bc1701c7">XNvm_ProcessMailbox()</a>, and <a class="el" href="group__xnvm__bbram__client__api.html#ga16b69cce167bd701e56511c099fdf150">XNVM_SLR_INDEX_SHIFT</a>.</p>

</div>
</div>
<a class="anchor" id="gae4085a2c2243377cae4029f3236684e7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XNvm_BbramZeroize </td>
          <td>(</td>
          <td class="paramtype">const XNvm_ClientInstance *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends IPI request to zeroize the BBRAM. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the client instance</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS If the BBRAM zeroize is successful</li>
<li>XST_INVALID_PARAM If there is a input validation failure</li>
<li>XST_FAILURE If there is a failure </li>
</ul>
</dd></dl>
<p>Performs input parameters validation. Return XST_INVALID_PARAM if input parameters are invalid.</p>
<p>Sends BBRAM Zeroize CDO command to PLM through IPI. Returns the response of the BBRAM Zeroize operation from the PLM</p>

<p>References <a class="el" href="common_2xnvm__defs_8h.html#afefb58b4bc539bff958b4da2dbdfdd15adb948dbf0612c47405ce1a41cf129085">XNVM_API_ID_BBRAM_ZEROIZE</a>, <a class="el" href="group__xnvm__mailbox__apis.html#ga3ce66c6266190912ba2552c2bc1701c7">XNvm_ProcessMailbox()</a>, and <a class="el" href="group__xnvm__bbram__client__api.html#ga16b69cce167bd701e56511c099fdf150">XNVM_SLR_INDEX_SHIFT</a>.</p>

<p>Referenced by <a class="el" href="group__xnvm__bbram__server__apis.html#ga85d604d634dbf207503a9128fee84a50">XNvm_BbramWriteAesKey()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
